<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Dwoo_Loader</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Dwoo_Loader</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">handles plugin loading and caching of plugins names/paths relationships</p>
<p class="description"><p>This software is provided 'as-is', without any express or implied warranty.  In no event will the authors be held liable for any damages arising from the use of this software.</p><p>This file is released under the LGPL  &quot;GNU Lesser General Public License&quot;  More information can be found here:  <a href="http://www.gnu.org/copyleft/lesser.html">http://www.gnu.org/copyleft/lesser.html</a></p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Jordi Boggiano &lt;<a href="mailto:j.boggiano@seld.be">j.boggiano@seld.be</a>&gt;</li>
				<li><span class="field">version:</span> 0.9.1</li>
				<li><span class="field">copyright:</span> Copyright (c) 2008, Jordi Boggiano</li>
				<li><span class="field">link:</span> <a href="http://dwoo.org/">http://dwoo.org/</a></li>
				<li><span class="field">date:</span> 2008-05-30</li>
				<li><span class="field">license:</span> <a href="http://www.gnu.org/copyleft/lesser.html">GNU Lesser General Public License</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Dwoo---Loader.php.html">/Dwoo/Loader.php</a> (line <span class="field"><a href="../__filesource/fsource_Dwoo__DwooLoader.php.html#a22">22</a></span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
												<div class="var-title">
					static <span class="var-type">array</span>
					<a href="#$classpath" title="details" class="var-name">$classpath</a>
				</div>
																<div class="var-title">
					static <span class="var-type">array</span>
					<a href="#$paths" title="details" class="var-name">$paths</a>
				</div>
																															</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
										
				<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#addDirectory" title="details" class="method-name">addDirectory</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$pluginDir</span>)
									</div>
														
				<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#loadPlugin" title="details" class="method-name">loadPlugin</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$forceRehash</span> = <span class="var-default">true</span>])
									</div>
														
				<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#rebuildClassPathCache" title="details" class="method-name">rebuildClassPathCache</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$cacheFile</span>)
									</div>
																																							</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$classpath" id="$classpath"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">array</span>
			<span class="var-name">$classpath</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooLoader.php.html#a40">40</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">stores the plugins names/paths relationships  don't edit this on your own, use addDirectory</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../Dwoo/Dwoo_Loader.html#methodaddDirectory">Dwoo_Loader::addDirectory()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$paths" id="$paths"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">array</span>
			<span class="var-name">$paths</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooLoader.php.html#a30">30</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">stores the plugin directories</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../Dwoo/Dwoo_Loader.html#methodaddDirectory">Dwoo_Loader::addDirectory()</a></li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>

						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodaddDirectory" id="addDirectory"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static addDirectory</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooLoader.php.html#a115">115</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">adds a plugin directory, the plugins found in the new plugin directory</p>
<p class="description"><p>will take precedence over the other directories (including the default  dwoo plugin directory), you can use this for example to override plugins  in a specific directory for a specific application while keeping all your  usual plugins in the same place for all applications.</p><p>TOCOM don't forget that php functions overrides are not rehashed so you  need to clear the classpath caches by hand when adding those</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">void</span>
		<span class="method-name">
			addDirectory
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$pluginDir</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$pluginDir</span><span class="var-description">: the plugin path to scan</span>			</li>
				</ul>
		
			
	</div>
<a name="methodloadPlugin" id="loadPlugin"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static loadPlugin</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooLoader.php.html#a83">83</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">loads a plugin file</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">void</span>
		<span class="method-name">
			loadPlugin
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$forceRehash</span> = <span class="var-default">true</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$class</span><span class="var-description">: the plugin name, without the Dwoo_Plugin_ prefix</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$forceRehash</span><span class="var-description">: if true, the class path caches will be rebuilt if the plugin is not found, in case it has just been added, defaults to true</span>			</li>
				</ul>
		
			
	</div>
<a name="methodrebuildClassPathCache" id="rebuildClassPathCache"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static rebuildClassPathCache</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooLoader.php.html#a49">49</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">rebuilds class paths, scans the given directory recursively and saves all paths in the given file</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">void</span>
		<span class="method-name">
			rebuildClassPathCache
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$cacheFile</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$path</span><span class="var-description">: the plugin path to scan</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$cacheFile</span><span class="var-description">: the file where to store the plugin paths cache, it will be overwritten</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 30 May 2008 04:51:44 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>